itemOffset

Type

function

Summary

Returns the number of items between the beginning of a value and an occurrence of a specified string.

Syntax

itemOffset(<itemToFind>, <stringToSearch> [, <itemsToSkip>])

Description

Use the itemOffset function to find which item a string occurs in.

The value returned by the itemOffset function is the number of the item where itemToFind first appears in stringToSearch. If the itemToFind is not in stringToSearch, the itemOffset function returns zero.

If the itemToFind contains more than one item, and the entire itemToFind appears in the stringToSearch, the itemOffset function returns the item number where the itemToFind starts.

If you specify how many itemsToSkip, the itemOffset function skips the specified number of items in the stringToSearch. The value returned is relative to this starting point instead of the beginning of the stringToSearch.

Parameters

Name	Type	Description
itemToFind	string
stringToSearch	string
itemsToSkip		A non-negative integer. If you don't specify how many itemsToSkip, the itemOffset function does not skip any items.

Examples

itemOffset("C","A,B,C,D,E") -- returns 3

itemOffset("C","A,B,C,D,E",2) -- returns 1

itemOffset("D,E","A,B,C,D,E") -- returns 4

Related

glossary: return, non-negative

keyword: item, integer, items, string

property: wholeMatches, itemDelimiter

control structure: function

function: wordOffset, offset, value

Compatibility and Support

Introduced

LiveCode 1.0

OS

mac

windows

linux

ios

android

Platforms

desktop

server

mobile